// -------------------------------------------------------------------------------
// IRCReporter v1.00
// -------------------------------------------------------------------------------

*1 -- Install
*2 -- Info
*3 -- Servers
*4 -- Config
*5 -- Problems
*6 -- Notes

// -------------------------------------------------------------------------------
// 1 -- Install
// -------------------------------------------------------------------------------

Extract the contents of this archive to your UT2003/System directory.


// -------------------------------------------------------------------------------
// 2 -- Info
// -------------------------------------------------------------------------------

IRCReporter is a serverside IRC reporter bot. It will sit in an IRC channel and
report what is happening in the current match to the channel.

It's that simple.

It currently doesn't support DM (I felt there was no need for it to). If there is
enough demand I will alter it so it does so.

IRCReporter requires patch 2316 (or whatever it is ;)


// -------------------------------------------------------------------------------
// 3 -- Servers
// -------------------------------------------------------------------------------

No serverpackages needed for this, it's a serverside mutator.

Just specify the mutator in your UCC server command like so:
	UCC Server CTF-Face3&Game=UnrealGame.CTFGame&Mutator=IRCReporter.IRC_Main

And you're done!

You will want to read the configuration section below though...


// -------------------------------------------------------------------------------
// 4 -- Config
// -------------------------------------------------------------------------------

IRCReporter can be configured through two methods: Editing the INI file, and console
commands while logged in as admin.

The INI file is fairly self explanatory (BotName, BotServer, BotPort, BotChannel, etc). 
Just note that BotPort is the port on the IRC server it connects to.

Adjustments through the console can be done after logging in as admin. Once you
are logged in you can use these commands:
	Admin Set IRCReporter.IRC_Main BotName <new name>
	Admin Set IRCReporter.IRC_Main BotServer <new server>
	Admin Set IRCReporter.IRC_Main BotPort <new Port>
	Admin Set IRCReporter.IRC_Main BotChannel <new channel>
	Admin Set IRCReporter.IRC_Main BotIdent <new ident>
Commit and execute your changes using:
	Admin Set IRCReporter.IRC_Main ExecuteChanges 1

The bot will then disconnect from IRC, and reconnect with your new settings.


// -------------------------------------------------------------------------------
// 5 -- Problems
// -------------------------------------------------------------------------------

If your bot, for some reason, fails to connect to IRC, you can tell it to re-try by
logging in as admin, and using this command:
		Admin Set IRCReporter.IRC_Main ExecuteChanges 1

If it STILL fails, try changing some settings, check whether you are looking in the
right channel and/or server for it, check whether the name you chose for your bot is
free, and if after all that it _STILL_ fails, email me and I'll find the problem.

Please check that the IRC server has not died/is still connectable by loading up
your IRC client, and connecting to the server yourself.


// -------------------------------------------------------------------------------
// 6 -- Notes
// -------------------------------------------------------------------------------

IRCReporter by [-will-] <will@byut.net>

Don't hesitate to email me bugs, suggestions, and comments.